/*
 * Copyright (c) 2010, okazoh_tk. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  - Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *  - Neither the name of the copyright holder nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ALKES_DEQUE_ITERATOR_H_INCLUDED_
#define ALKES_DEQUE_ITERATOR_H_INCLUDED_

#include "alkes/internal.h"

namespace alkes {

/// \addtogroup core
//@{

class Deque;
class DequeIteratorFactory;

class AL_EXPORT DequeIterator
{
public:

    DequeIterator();
    DequeIterator(void* object, DequeIterator* prev, DequeIterator* next);
    ~DequeIterator();

    DequeIterator* getNext();
    const DequeIterator* getNext() const;
    DequeIterator* getPrev();
    const DequeIterator* getPrev() const;

    operator void* ();
    operator const void* () const;

    void* getObject() const;

    void set(void* obj, DequeIterator* prev, DequeIterator* next);
    void setObject(void* obj);
    void setPrev(DequeIterator* prev);
    void setNext(DequeIterator* next);

private:
    DequeIterator* prev_;
    DequeIterator* next_;
    void* object_;
};

template<class T>
T iter_cast(const DequeIterator* ptr)
{
    return reinterpret_cast<T>(ptr->getObject());
}

template<class T>
T iter_cast(const DequeIterator& ptr)
{
    return reinterpret_cast<T>(ptr.getObject());
}

//@}

}

#endif
